/*
 * Copyright 2009 SHOP.COM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.shop.opensocial.mediated.types;

/**
 * Independent mediator for corresponding OpenSocial type
 *
 * @author Jordan Zimmerman
 */
public interface AccountMediator
{
	/**
	 * The top-most authoritative domain for this account, e.g. "twitter.com". This is the Primary
	 * Sub-Field for this field, for the purposes of sorting and filtering.
	 *
	 * @return the domain
	 */
	public String getDomain();

	/**
	 * A user ID number, usually chosen automatically, and usually numeric but sometimes alphanumeric,
	 * e.g. "12345" or "1Z425A".
	 *
	 * @return the userId
	 */
	public String getUserId();

	/**
	 * An alphanumeric user name, usually chosen by the user, e.g. "jsmarr".
	 *
	 * @return the username
	 */
	public String getUsername();
}
